home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / finder2.arc / SYSOP20.REF < prev   
Encoding:
Text File  |  1987-09-20  |  13.4 KB  |  241 lines
  1. SYSOP20.REF: FINDER / FINDHW V. 2.0 Sysop Information and Reference
  2.  
  3. 1.  These instructions are abbreviated, so be sure to READ the FINDER
  4. documentation files and the paper on FINDER in the 6th ARRL Computer Networking
  5. Conference Proceedings first for general background information.  When we are
  6. referring to the FINDER system in either the emergency responder (ER) mode or
  7. the health and welfare (patient/victim tracking) mode (HW mode), we usually use
  8. the word "FINDER".  If we need to distinguish between the two, "FINDER" will be
  9. used for the ER case, and "FINDHW" will be used for the HW case.
  10.  
  11. 2.  You need an IBM PC or compatible with one serial port and with at least two
  12. drives, one of which should be a hard disk or hard card, if possible.  FINDER
  13. has been tested on a PC, XT, AT and a PC Convertible using DOS 3.2.
  14. (The program also appears to run fairly well on the PCjr.)
  15.  
  16. 3.  You also need a TNC with WA8DED firmware (EPROM).  FINDER has been
  17. tested on several TNC-1's with WA8DED firmware Version 1.1 modified for
  18. 8 simultaneous connects and on several TNC-2's with WA8DED firmware
  19. Version 2.0 with four simultaneous connects.  We noted that the channel
  20. polling loop runs about 3 times faster on the TNC-1.  If your usage is
  21. totally non-commercial, you can get the WA8DED public domain firmware
  22. yourself from many sources; see your local packet hacker.  IF ALL ELSE
  23. FAILS, you can get it from us by sending two 27C64 EPROMS (for the
  24. TNC-1) or one 27C256 EPROM (for the TNC-2) to Dave Palmer, N6KL, or
  25. W. E. Moerner, WN6I.  Take a few minutes to learn the DED user mode command
  26. syntax - it is different from the TAPR syntax, but easy to learn.
  27.  
  28. 5.  The FINDER / FINDHW program is in the public domain and is available
  29. for non-commercial, non-profit use from WN6I or N6KL by sending a blank,
  30. formatted 5 1/4" (360 kB) or 3 1/2" (720 kB) floppy with SASE for return
  31. to you.  The cost to you is the cost of the diskette and return postage.
  32. We have included a configuration file facility so that you can tailor
  33. many parameters to your system.  If you want small changes in the code,
  34. we will try to accommodate you.
  35.  
  36. 6. FINDER file usage:
  37.  
  38.    FINDERER.DAT                 the database itself - all records
  39.    PHONEER.NDX                  index file for phonenum searches
  40.    ORIGINER.NDX                 index file for origin searches
  41.  
  42.    FINDERER.JRN                 journal file - a normal ASCII file containing
  43.                                 a listing of all valid current information
  44.                                 packets.  May be edited or printed or used as
  45.                                 input to the REBUILDE program to recover a
  46.                                 damaged or erased database.
  47.  
  48.    FINDERER.BAK                 backup of the database
  49.    PHONEER.BAK                  phonenum index file backup
  50.    ORIGINER.BAK                 origin index file backup
  51.  
  52. 7. FINDHW file usage:
  53.  
  54.    FINDERHW.DAT                 the database itself - all records
  55.    PHONEHW.NDX                  index file for phonenum searches
  56.    LNAMEHW.NDX                  index file for last name searches
  57.    CLOCHW.NDX                   index file for cloc searches
  58.  
  59.    FINDERHW.JRN                 journal file - a normal ASCII file containing
  60.                                 a listing of all valid current information
  61.                                 packets.  May be edited or printed or used as
  62.                                 input to the REBUILDH program to recover a
  63.                                 damaged or erased database.
  64.  
  65.    FINDERHW.BAK                 backup of the database
  66.    PHONEHW.BAK                  phonenum index file backup
  67.    LNAMEHW.BAK                  lastname index file backup
  68.    CLOCHW.BAK                   cloc index file backup
  69.  
  70. 8.  Before starting FINDER, be sure your hardware is set up correctly.  Test
  71. the TNC and WA8DED firmware by using your own terminal emulator first.
  72.  
  73. 9.  Edit the configuration file FINDER.CFG to reflect your system
  74. configuration.  The configuration file is self-documenting for the most part.
  75. Multiple comment lines starting with a semi-colon are allowed at the beginning
  76. of the file.  Thereafter, each line begins in column 1 with the desired value
  77. of the parameter.  Follow each parameter with at least one space and a
  78. semicolon.  Comments may follow the semicolon.  Here is a description of each
  79. parameter:
  80.  
  81.         a. Choose prompted or automatic mode.  This is described below in
  82.            number 11.
  83.         b. Maximum number of connections.  Specify 8, unless you want to
  84.            restrict the number of simultaneous connects to a smaller number.
  85.            The program will determine the maximum number your firmware will
  86.            support and will adjust accordingly.
  87.         c. Backup drive and path.  This is the drive:path for the automatic
  88.            backup of the database files.  Must end with a "\".
  89.         d. Journaling drive and path.  This is the drive:path for the
  90.            automatic journaling of valid database transactions. Must end
  91.            with a "\".
  92.         e. Backup interval.  Number of new entries before the entire database
  93.            is written to the backup file. 0 means no backup.
  94.         f. Journaling interval.  Number of new entries to the database before
  95.            the journal file is updated.  Max=25.
  96.         g. TNC serial port.  May be 1 (for COM1), 2 (for COM2), or 0 if you
  97.            are using a non-standard serial port.  If you specify 0, FINDER
  98.            will not initialize the serial port and you must have initialized
  99.            it separately to N, 8, 1, and whatever baud rate you like.
  100.         h. Serial port address.  FINDER allows you to use any serial port you
  101.            like.  Specify here the base address of the UART chip.  COM1 is
  102.            usually $3F8 and COM2 is usually $2F8.  Interrupts are not used,
  103.            thus the interrrupt level need not be specified.
  104.         i. Serial port baud rate.  We suggest 4800 or 9600 baud.
  105.         j. Serial port retry count. Try 10.  If you regularly get
  106.            TNC timeout messages, adjust this value higher.
  107.         k. Enable/disable interrupts during serial port I/O.  We strongly
  108.            suggest enable, unless your computer has difficulty keeping up with
  109.            the baud rate.
  110.         l. Area code abbreviation checking (yes/no).  Yes means a table of
  111.            valid 1-digit abbreviations for specific area codes follows.  No
  112.            means any 3-digit number will be allowed for the area code.
  113.         m. Area code table.  Copy the example in the supplied .cfg file.
  114.            End the table with 3 zeros for the area code and one zero for
  115.            the abbreviation.
  116.         n. TNC commands to be issued during startup of FINDER.  The first
  117.            line begins with a single slash.  Change the callsign to your own.
  118.            All the other parameters have been determined to be reasonably
  119.            optimal for efficient FINDER database operation.  You may include
  120.            other commands or delete commands from this list if you wish.
  121.            End the TNC command list with a slash.
  122.  
  123. 10.  To start FINDER, note that there are two FINDxx.BAT files on the diskette.
  124. FINDER.BAT starts FINDER (Emergency Responder mode), and FINDHW.BAT starts
  125. FINDHW (Health and Welfare mode).  If you have selected automatic startup, be
  126. sure the drives have disks in them and that the TNC is on.  Start the execution
  127. by typing either "FINDER" or "FINDHW".
  128.  
  129. 11.  The startup sequence is self-explanatory.  If you have selected automatic
  130. startup, no prompting will be done and after processing the .cfg file and
  131. opening the database files, the program will automatically enter host mode and
  132. begin polling the available channels for data.  If you have selected prompted
  133. startup, you will be prompted to put a diskette in the drive you have selected
  134. for the backup/journaling function.  If previous database files are found, they
  135. are opened.  If none are found, new database files are created.  Note that
  136. after each exercise, you should rename the database files to start with a fresh
  137. (empty) database.  Then you are prompted to turn on the TNC.  When TNC-computer
  138. synchronization is established, the run-time status screen is displayed and
  139. several TNC parameters are set.  FINDER is running!
  140.  
  141. 12.  The sysop keyboard can enter current information input and search requests
  142. like any connected channel, but don't try to type too fast.  See the file
  143. PACKET20.REF for a summary of the standard packet operator procedures.
  144.  
  145. 13.  The sysop can also send commands directly to the TNC by typing <ESC> and
  146. the command as usual.  Some commands (such as "d" for disconnect) can reference
  147. a specific channel:  to set the channel for these commands, first type
  148. "<ESC>sn<CR>", where n is the channel number.  The currently selected channel
  149. is marked with a triangular arrow on the sysop screen.  For example, to force a
  150. disconnect on channel 3, type "<ESC>s3 <CR> <ESC>d <CR>".
  151.  
  152. 14.  The sysop can send messages to connected channels in several ways:
  153. (a) by typing "<ESC>nmessage<CR>" where n is the channel number, (b) by using
  154. the "tell" command described in PACKET20.REF, and (c) by simply typing a line
  155. beginning with a letter that is not recognizable as any other command.  In the
  156. last case, the message is sent to the currently selected channel.  Note that
  157. the sysop can send a QST to all connected channels by typing "tell all msg"<CR>
  158. or "tell * msg"<CR>, where "msg" is the text to be sent.
  159.  
  160. 15.  Special SYSOP-only commands:
  161.  
  162.         s<CR>                   lists a summary of the database, i. e., the
  163.                                 number of records (people) at each orig or
  164.                                 cloc
  165.  
  166.         l all<CR>               lists all entries in the database in record
  167.                                 numerical order
  168.  
  169.         l nnnn<CR>              list record number nnnn
  170.  
  171.         d nnnn<CR>              delete record number nnnn (careful!)
  172.  
  173. 16.  Special PF keys:
  174.  
  175.         F1              Immediate database backup: closes all files, copies
  176.                         current database files to the .BAK versions, and
  177.                         flushes the last few valid current information
  178.                         packets into the .JRN file
  179.  
  180.         F2              Mode selector for the currently selected channel.
  181.                         Pressing the key cycles through three modes:  mode 0 -
  182.                         all packet operator functions enabled; mode 1 - "tell"
  183.                         and "users" only enabled; and mode 2 - chat mode only,
  184.                         which looks like normal terminal operation.  The
  185.                         current mode for each channel is indicated on the sysop
  186.                         screen.  Mode 0 has no character next to the channel
  187.                         number, mode 1 has a small square, and mode 2 has an
  188.                         "x" next to the channel number.  Upon startup, all
  189.                         channels are set to mode 0.  Mode 2 is useful to
  190.                         prevent a "jammer" from tampering with the database, or
  191.                         for normal terminal-mode connection to another station
  192.                         or BBS.  Mode 1 is useful for a round-table discussion
  193.                         only, without access to the database.
  194.  
  195.         <CTRL>F3        Shut down the program gracefully.  If the program is
  196.                         subsequently restarted from DOS, it will pick up where
  197.                         it left off.
  198.  
  199.         F5              Suspend program execution.  The TNC transmit is
  200.                         disabled, and polling stops.  Use this if you have
  201.                         to change radios for some reason.
  202.  
  203.         F6              Redraw the sysop screen.
  204.  
  205.         F7              Send a full ASCII report of the database to file
  206.                         FINDER.RPT on a:.
  207.  
  208.         F8              Send a full ascii report of the database to file
  209.                         FINDER.RPT on b:.
  210.  
  211.         F10             Toggle printer.  All lines printed in the main part of
  212.                         the sysop screen will be echoed on the printer.  NOTE:
  213.                         this slows down the polling loop dramatically.
  214.  
  215. 17.  To terminate execution, use the sequence <CTRL><F3>.  <CTRL><BREAK> may be
  216. used to exit only during a tncrecover.  <CTRL><F3> is best, because the program
  217. then properly closes all files.
  218.  
  219. 18.  If you have TNC errors, under certain conditions the program will execute
  220. a TNC reset and/or a TNC recovery procedure.  When this occurs, the first thing
  221. that happens is a backup.  The program should recover by itself.  Be patient.
  222. As a last resort, you can try turning off the TNC and then turn it on again.
  223. Note that you will then lose all packets in the receive and transmit queues,
  224. however.  If you are really paranoid and you are using an IBM PC, you can
  225. connect the cassette motor relay to the reset circuit on your TNC.  The TNC
  226. reset procedure will close the relay if it appears that the TNC fails to
  227. respond.
  228.  
  229. 19. Good luck!
  230.  
  231. 20. If good luck is insufficient, or if you have comments or suggestions,
  232. contact either of us at
  233.  
  234. W. E. Moerner, WN6I, 1003 Belder Drive, San Jose, CA 95120  408-997-3195
  235.      (WN6I @ NV6Z, MOERNER@IBM.COM (csnet))
  236.  
  237. Dave Palmer, N6KL, 382 Union Ave. #C, Campbell, CA, 95008  408-559-1669
  238.      (N6KL @ NV6Z, N6KL@IBM.COM (csnet) or 73357,3157 (Compuserve))
  239.  
  240. END SYSOP20.REF
  241.